Result Class Reference

The Result class. More...

Public Member Functions
Value	getValue ()
	Get value. More...
Mask	getMask ()
	Get mask. More...
ByteView	getByteView ()
	byte view. More...
int	getLevel ()
	Get level. More...
int	getIteration ()
	Get iteration. More...
int	getStartBytePos ()
	Get start (byte). More...
int	getStartBitPos ()
	Get start (bit). More...
int	getByteLength ()
	Get length (bytes). More...
int	getBitLength ()
	Get length (bits). More...
String	getName ()
	Get name. More...
Structure	getStructure ()
	Get structure. More...
Element	getElement ()
	Get structure element. More...
	update (Value value)
	Update result. More...
RESULT_TYPE	getType ()
	Get type of result. More...

Detailed Description

The Result class.

Result objects are created during the structure mapping process. Depending on their type they refer to a structure or struct element and a value.

Author

Andreas Pehnack

Date

2009-09-08

Member Function Documentation

getBitLength()

int getBitLength

(

)

Get length (bits).

Returns the bit length of the result in the input file.

Author

Andreas Pehnack

Date

2012-04-22

Returns

The bit length of the result

getByteLength()

int getByteLength

(

)

Get length (bytes).

Returns the byte length of the result in the input file.

Author

Andreas Pehnack

Date

2012-04-22

Returns

The byte length of the result

getByteView()

ByteView getByteView

(

)

byte view.

Returns the byte view object the result was created for. This is useful to access the raw data of large binary element results.

Author

Andreas Pehnack

Date

2014-01-26

Returns

The level of the result

getElement()

Element getElement

(

)

Get structure element.

Returns the structure elementof the result. This is only valid if the result ist of type structure.

Author

Andreas Pehnack

Date

2012-04-22

Returns

The structure element of the result

getIteration()

int getIteration

(

)

Get iteration.

Returns the interation of a result in a sequence of repeated elements.

Author

Andreas Pehnack

Date

2012-04-22

Returns

The iteration of the result

getLevel()

int getLevel

(

)

Get level.

Returns the level of a result in the results tree.

Author

Andreas Pehnack

Date

2012-04-22

Returns

The level of the result

getMask()

Mask getMask

(

)

Get mask.

Mask results refer to a mask object.

Author

Andreas Pehnack

Date

2012-03-22

Returns

The mask or NULL if there is none

getName()

String getName

(

)

Get name.

Returns the name of the result.

Author

Andreas Pehnack

Date

2012-04-22

Returns

The name of the result

getStartBitPos()

int getStartBitPos

(

)

Get start (bit).

Returns the bit position of the result in the input file.

Author

Andreas Pehnack

Date

2012-04-22

Returns

The byte position of the result

getStartBytePos()

int getStartBytePos

(

)

Get start (byte).

Returns the byte position of the result in the input file.

Author

Andreas Pehnack

Date

2012-04-22

Returns

The byte position of the result

getStructure()

Structure getStructure

(

)

Get structure.

Returns the structure of the result. This is only valid if the result ist of type structure.

Author

Andreas Pehnack

Date

2012-04-22

Returns

The structure of the result

getType()

RESULT_TYPE getType

(

)

Get type of result.

Returns type of a result. This can be RESULT_STRUCTURE_START_TYPE, RESULT_STRUCTURE_END_TYPE, RESULT_STRUCTURE_ELEMENT_TYPE, RESULT_MASK_TYPE or RESULT_MULTI.

Author

Andreas Pehnack

Date

2015-10-17

Returns

The type of the result

getValue()

Value getValue

(

)

Get value.

Each result has a value.

Author

Andreas Pehnack

Date

2009-09-08

Returns

The value or NULL if there is none

update()

update

(

Value

value

)

Update result.

Modify byte array with new value.

Author

Andreas Pehnack

Date

2015-10-17

Parameters

[in]

value

New value for result

---

The documentation for this class was generated from the following file:

• Generated/synalysis_wrap_lua.cpp